/*
 * Copyright (c) 2003-2005
 * XDoclet Team
 * All rights reserved.
 */
package org.xdoclet.plugin.hibernate.qtags;

import org.xdoclet.plugin.hibernate.qtags.parameter.*;

/**
 * Mapped classes must declare the primary key column of the database table. Most classes will also have a
 * JavaBeans-style property holding the unique identifier of an instance. The &lt;id&gt; element defines the
 * mapping from that property to the primary key column.
 *
 * @qtags.location method
 * @qtags.location field
 */
public interface HibernateIdTag extends com.thoughtworks.qdox.model.DocletTag, Column, Length, Type, UnsavedValue, Node,
    Name, Access {
    /**
     * The key generator class. Hibernate recognizes standart generator
     * classes:  "uuid.hex", "uuid.string", "increment", "assigned", "native", "identity", "sequence", "hilo", "seqhilo",
     * "foreign" ( See hibernate documentation for meaning of those )  as well as fully qualified name of custom generator
     * class
     *
     * @qtags.required
     */
    String getGeneratorClass();
}